====== Shortcut Plugin ======

---- plugin ----
description: Link pages using short names and add some descriptive info about the anchor to the page
author     : Ilya Lebedev
email      : ilya@lebedev.net
type       : syntax
lastupdate : 2007-02-05
compatible :
depends    :
conflicts  : backlinks
similar    :
tags       : alias, shortcut, links

downloadurl: https://trello.com/1/cards/5b5e1345029192de316fa5e0/attachments/5b5e135eac469d4498f5ca3d/download/shortcut.zip
bugtracker : 
sourcerepo : 
donationurl: 

screenshot_img: 
----

This plugin is intended to provide shortcuts functionality for DokuWiki. Its main purpose is to link pages using short names and add some descriptive info about the anchor to the page. Additionally, it allows to replace link title with the specified image.

===== Syntax =====

==== Shortcut definition ====

  <shortcut name[|image]>[description]</shortcut>

^ ''name''     | Shortcut name  | Used in links to this page | required |
^ ''image''    | Shortcut image | Replaces link with the supplied images, using 'imline icon' technique.  | optional |
^ ''descripts''| Description    | Text, displayed in the tooltip for the link | optional |

==== Anchor ====

  [[target [|title] ]]

Anchor does replace the standard anchor syntax with fallback compatibility. If plugin could not find the shortcut , it creates the standard DokuWiki anchor.

===== Use cases =====

  * Astronomical pages in the Wiki, when you want to have planet symbols in the texts, when refer to them.
  * Mathematical pages with the same purposes.
  * Big wiki book, with deep paths.

===== Notes =====

  * Plugin tested with [[http://www.splitbrain.org/_media/projects/dokuwiki/dokuwiki-2006-11-06.tgz?id=projects%3Adokuwiki&cache=cache|rc2006-11-06]] DokuWiki release.
  * You need to open pages with [[devel:caching#purging_the_cache|purge=true]] param in the URL to reset the cache to see changes immediately or wait [[config:cachetime|purge cache time]].

===== Configuration =====

This release does not support configuration yes, although it contains some config files for the future use.

===== How to install =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Changelog =====

  * **2007-05-02 Version 0.1.1**:
    * First public release

===== Todo =====

===== Discussion =====

Question: I have a problem with making shortcut plugin work properly.  When I installed it, all text linked to other pages or those linked to wikipedia disappears.  Once I remove it, it recovers.  Does anybody have any idea? //Yasunori Hayashi//
> Hi, this plugin has not been updated for a really long time, either there were no compatibility testing against the latest dokuwiki releases. Sorry, but i'm not sure if i ever get the time to update it. //Ilya//

===== Feature request =====